EDMA.h

Go to the documentation of this file.

#ifndef _EDMA_H
#define _EDMA_H

/*
 ******************************************************************************
 * Defines, Macros and Typedefs 
 *****************************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
#define TRUE (1u)
#endif
#ifndef CLEAR
#define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
#define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
#define BITS_IN_BYTE (8u)
#endif
#ifndef BITS_IN_32
#define BITS_IN_32  (32u)
#endif
#ifndef BITS_IN_16
#define BITS_IN_16  (16u)
#endif
#ifndef BYTES_IN_32
#define BYTES_IN_32  (4u)
#endif
#ifndef BYTES_IN_16
#define BYTES_IN_16  (2u)
#endif
#ifndef BIT_DEFINITION
#define BIT_DEFINITION
#define BIT0  (1u << 0u)
#define BIT1  (1u << 1u)
#define BIT2  (1u << 2u)
#define BIT3  (1u << 3u)
#define BIT4  (1u << 4u)
#define BIT5  (1u << 5u)
#define BIT6  (1u << 6u)
#define BIT7  (1u << 7u)
#define BIT8  (1u << 8u)
#define BIT9  (1u << 9u)
#define BIT10 (1u << 10)
#define BIT11 (1u << 11)
#define BIT12 (1u << 12)
#define BIT13 (1u << 13)
#define BIT14 (1u << 14)
#define BIT15 (1u << 15)
#define BIT16 (1u << 16)
#define BIT17 (1u << 17)
#define BIT18 (1u << 18)
#define BIT19 (1u << 19)
#define BIT20 (1u << 20)
#define BIT21 (1u << 21)
#define BIT22 (1u << 22)
#define BIT23 (1u << 23)
#define BIT24 (1u << 24)
#define BIT25 (1u << 25)
#define BIT26 (1u << 26)
#define BIT27 (1u << 27)
#define BIT28 (1u << 28)
#define BIT29 (1u << 29)
#define BIT30 (1u << 30)
#define BIT31 (1u << 31)
#endif

/* For config */
#define CHANNEL_TO_CHANNEL_LINKING_ON_MAJOR_LOOP_EN  (0x80000000u)
#define CHANNEL_TO_CHANNEL_LINKING_ON_MAJOR_LOOP_DIS (0x00000000u)
#define CHANNEL_TO_CHANNEL_LINKING_ON_MINOR_LOOP_EN  (0x80000000u)
#define CHANNEL_TO_CHANNEL_LINKING_ON_MINOR_LOOP_DIS (0x00000000u)
#define DMA_8_BIT_SOURCE                             (0x00000000u)
#define DMA_16_BIT_SOURCE                            (0x01000000u)
#define DMA_32_BIT_SOURCE                            (0x02000000u)
#define DMA_64_BIT_SOURCE                            (0x03000000u)
#define DMA_8_BIT_TARGET                             (0x00000000u)
#define DMA_16_BIT_TARGET                            (0x00010000u)
#define DMA_32_BIT_TARGET                            (0x00020000u)
#define DMA_64_BIT_TARGET                            (0x00030000u)
#define DONT_STALL_DMA                               (0x00000000u)
#define STALL_DMA_4_CYCLES                           (0x00008000u)
#define STALL_DMA_8_CYCLES                           (0x0000C000u)
#define DMA_ISR_HALF_WAY_THROUGH                     (0x00000004u)
#define DMA_ISR_WHEN_DONE                            (0x00000002u)
#define DMA_START                                    (0x00000001u)

#define DMA_SIZE_8_BIT  (0x00u)
#define DMA_SIZE_16_BIT (0x01u)
#define DMA_SIZE_32_BIT (0x02u)
#define DMA_SIZE_64_BIT (0x03u)
#define DMA_BWC_NONE    (0x00u)
#define DMA_BWC_4_CYCLE_STALL (0x02u)
#define DMA_BWC_8_CYCLE_STALL (0x03u)

/* For Mux Config */
#define DMA_MUX_ENABLED                              (0x80u)
#define DMA_MUX_DISABLED                             (0x00u)
#define DMA_TRIGGER_ENABLED                          (0x40u)
#define DMA_TRIGGER_DISABLED                         (0x00u)

/*** Function Macros ***/
#ifndef N_ELEMENTS
#define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

#define CURRENT_MAJOR_ITERATION(xx)                  ((uint32_t)((xx) << 16u))
#define DMA_OFFSET(xx)                               ((uint32_t)(xx))
#define NUMBER_OF_MAJOR_ITERATIONS(xx)               ((uint32_t)((xx) << 16u))
#define DMA_CLEAR_ISR_FLAG(XX)                       EDMA.CIRQR.R = XX
#define DMA_MUX_ENABLE(XX, YY)                       DMAMUX.CHCONFIG[XX].B.ENBL = YY
/*** Enums ***/
enum DMA_CHANNEL_STATE
{
  DMA_SERVICE_REQUEST_ASSERTED, DMA_EXECUTING, DMA_COMPLETED_MINOR_LOOP,
  DMA_COMPLETED_MAJOR_LOOP
};
enum DMA_MUX_SOURCES
{
  DMA_SOURCE_DSPI0_TX = 1, DMA_SOURCE_DSPI0_RX, DMA_SOURCE_DSPI1_TX,
  DMA_SOURCE_DSPI1_RX, DMA_SOURCE_DSPI2_TX, DMA_SOURCE_DSPI2_RX,
  DMA_SOURCE_DSPI3_TX, DMA_SOURCE_DSPI3_RX, DMA_SOURCE_CTU, DMA_SOURCE_FIF01,
  DMA_SOURCE_FIFO2, DMA_SOURCE_FIFO3, DMA_SOURCE_FIFO4, DMA_SOURCE_FLEX_PWM_WR,
  DMA_SOURCE_FLEX_PWM_RD, DMA_SOURCE_ETIMER0_CH0, DMA_SOURCE_ETIMER0_CH1,
  DMA_SOURCE_ETIMER1_CH0, DMA_SOURCE_ETIMER1_CH1, DMA_SOURCE_ADC0,
  DMA_SOURCE_ADC1, DMA_SOURCE_ALWAYS
};
/*** TypeDefs ***/
typedef __attribute__(( aligned(32) ))  union
{
  struct
  {
    uint32_t SADDR; /* source address */
    uint16_t SMOD :5; /* source address modulo */
    uint16_t SSIZE :3; /* source transfer size */
    uint16_t DMOD :5; /* destination address modulo */
    uint16_t DSIZE :3; /* destination transfer size */
    int16_t SOFF; /* signed source address offset */
    uint32_t NBYTES; /* inner (“minor”) byte count */
    int32_t SLAST; /* last destination address adjustment, or */
    /* scatter/gather address (if e_sg = 1) */
    uint32_t DADDR; /* destination address */
    uint16_t CITERE_LINK :1;
    uint16_t CITER :15;
    int16_t DOFF; /* signed destination address offset */
    int32_t DLAST_SGA;
    uint16_t BITERE_LINK :1; /* beginning ("major") iteration count */
    uint16_t BITER :15;
    uint16_t BWC :2; /* bandwidth control */
    uint16_t MAJORLINKCH :6; /* enable channel-to-cannel link */
    uint16_t DONE :1; /* channel done */
    uint16_t ACTIVE :1; /* channel active */
    uint16_t MAJORE_LINK :1; /* enable channel-to-channel link */
    uint16_t E_SG :1; /* enable scatter/gather descriptor */
    uint16_t D_REQ :1; /* disable IRQ request when done */
    uint16_t INT_HALF :1; /* interrupt on citer = (biter >> 1) */
    uint16_t INT_MAJ :1; /* interrupt on major loop completion */
    uint16_t START :1; /* explicit channel start */
  } P;
  struct
  {
    vuint32_t SETTINGS[8u];
  } A;
} TCD_t;
/*
 ******************************************************************************
 * Declarations 
 *****************************************************************************/
/*** Extern ***/

/*** Globals ***/

/*** Static Globals ***/

/*
 ******************************************************************************
 * Function Prototypes 
 *****************************************************************************/
/*
 ******************************************************************************
 *
 * Function:          vfnDMASet()
 *
 */
void vfnDMASet(uint8_t u8Chan, uint8_t *pu8DestAddr, uint8_t *pu8SourceAddr,
               uint16_t u16NOfBytes);
/*
 ******************************************************************************
 *
 * Function:          vfnDMAConfig()
 *
 */
void vfnDMAConfig(TCD_t *ptMyTCD, uint8_t u8Channel);
/*
 ******************************************************************************
 *
 * Function:          vfnDMAStart()
 *
 */
void vfnDMAStart(const uint8_t u8Chan);
/*
 ******************************************************************************
 *
 * Function:          vfnDMAEnable()
 *
 */
void vfnDMAEnable(const uint8_t u8Chan);
/*
 ******************************************************************************
 *
 * Function:          vfnDMAEnable()
 *
 */
uint8_t u8fnDMAPending(const uint8_t u8Chan);
/*
 ******************************************************************************
 *
 * Function:          u8fnDMACopyArray()
 *
 */
void vfnDMACopyArray(uint8_t* pu8Source, uint8_t* pu8Target, uint16_t u16Size,
                     uint8_t u8Channel);
/*
 ******************************************************************************
 *
 * Function:          u8fnWaitForDMA()
 *
 */
uint8_t u8fnWaitForDMA(uint8_t u8Channel);
/*
 ******************************************************************************
 *
 * Function:          u8fnDMAReturnChannelStatus()
 *
 */
uint8_t u8fnDMAReturnChannelStatus(uint8_t u8Channel);
/*
 ******************************************************************************
 *
 * Function:          vfnDMAMUXInit()
 *
 */
void vfnDMAMUXInit(uint8_t u8DMACh, uint8_t u8DMAMuxSource, 
                   uint8_t u8Trigger, uint8_t u8Enable);
/*
 ******************************************************************************
 *
 * Function:          vfnDMAMuxEnable()
 *
 */
void vfnDMAMuxEnable(uint8_t u8DMACh, uint8_t u8Enable);
/*
 ******************************************************************************
 *
 * Function:          u8fnDMAMuxChEnStatus()
 *
 */
uint8_t u8fnDMAMuxChEnStatus(uint8_t u8DMACh);
#endif /* _FILENAME_H */